Skip to content

feat:Add usage_iframe_url and usage_iframe_dark_mode_url to metronome_links schemas #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
github-actions merged 1 commit into from
Apr 21, 2025
Merged

feat:Add usage_iframe_url and usage_iframe_dark_mode_url to metronome_links schemas #73

github-actions merged 1 commit into from
Apr 21, 2025

Conversation

@HavenDV
Copy link
Contributor

@HavenDV HavenDV commented Apr 21, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • New Features
    • Added new URLs for viewing the customer usage dashboard in both normal and dark modes within API responses.
  • Documentation
    • Updated descriptions and examples to reflect the new dashboard URL properties.

@coderabbitai
Copy link

coderabbitai bot commented Apr 21, 2025 •
edited
Loading

Walkthrough

Two new string properties, usage_iframe_url and usage_iframe_dark_mode_url, were added to the metronome_links object within both the ManageApiSubscriptionResponse and MetronomeLinks schemas in the OpenAPI specification. These properties provide URLs for displaying the customer usage dashboard in standard and dark modes. Descriptions and example values for these properties were also included to clarify their intended use.

Changes

File Change Summary
src/libs/Ideogram/openapi.yaml Added usage_iframe_url and usage_iframe_dark_mode_url string properties to metronome_links in ManageApiSubscriptionResponse and MetronomeLinks schemas, with descriptions and example values.

Poem

Two new URLs hop into the spec,
For dashboards light and dark—what the heck!
Now users can see, in any mode they please,
Their usage displayed with comfort and ease.
The OpenAPI garden grows with care,
As features blossom everywhere! 🐇✨

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot enabled auto-merge April 21, 2025 21:20
@github-actions github-actions bot merged commit bb4bff7 into main Apr 21, 2025
3 of 4 checks passed
@github-actions github-actions bot deleted the bot/update-openapi_202504212119 branch April 21, 2025 21:21
@coderabbitai coderabbitai bot changed the title feat:@coderabbitai feat:Add usage_iframe_url and usage_iframe_dark_mode_url to metronome_links schemas Apr 21, 2025
coderabbitai[bot]
coderabbitai bot reviewed Apr 21, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
src/libs/Ideogram/openapi.yaml (2)

1433-1439: Add URL format hint to new properties
The usage_iframe_url and usage_iframe_dark_mode_url properties represent URLs. Consider adding format: uri to these schema definitions to improve validation and tooling support:

 properties:
   usage_iframe_url:
     title: usage_iframe_url
     type: string
+    format: uri
     description: The URL to display the customer usage dashboard.
   usage_iframe_dark_mode_url:
     title: usage_iframe_dark_mode_url
     type: string
+    format: uri
     description: 'The URL to display the customer usage dashboard, in dark mode.'

1442-1443: Sync schema example with property definitions
The MetronomeLinks example now includes the two new usage URLs. Verify that the example ordering reflects the declared property order (invoices, credits, usage) or adjust for consistency. You may also want to include realistic example values (e.g., https://app.ideogram.ai/usage?iframe=true) to guide users.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cb7978e and 7b06f17.

⛔ Files ignored due to path filters (1)
  • src/libs/Ideogram/Generated/Ideogram.Models.MetronomeLinks.g.cs is excluded by !**/generated/**
📒 Files selected for processing (1)
  • src/libs/Ideogram/openapi.yaml (2 hunks)
🔇 Additional comments (1)
src/libs/Ideogram/openapi.yaml (1)

1407-1408: Include new fields in ManageApiSubscriptionResponse example
The example under ManageApiSubscriptionResponse.metronome_links correctly demonstrates the newly added usage_iframe_url and usage_iframe_dark_mode_url properties. Ensure that any example consumers or documentation generators pick up these additions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@github-actions github-actions[bot] github-actions[bot] approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@HavenDV